<!--
  This file is a part of the open-eBackup project.
  This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
  If a copy of the MPL was not distributed with this file, You can obtain one at
  http://mozilla.org/MPL/2.0/.
  
  Copyright (c) [2024] Huawei Technologies Co.,Ltd.
  
  THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
  EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
  MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
  -->


<!DOCTYPE html
  PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
      <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="DC.Type" content="topic">
<meta name="DC.Title" content="Configuring Management Data Backup">
<meta name="product" content="">
<meta name="DC.Relation" scheme="URI" content="admin_mngbackup_000000.html">
<meta name="prodname" content="">
<meta name="version" content="">
<meta name="brand" content="30-OceanProtect Appliance 1.5.0-1.6.0 Help Center">
<meta name="DC.Publisher" content="20241029">
<meta name="DC.Format" content="XHTML">
<meta name="DC.Identifier" content="admin_mngbackup_000001">
<meta name="DC.Language" content="en-us">
<link rel="stylesheet" type="text/css" href="public_sys-resources/commonltr.css">
<title>Configuring Management Data Backup</title>
</head>
<body style="clear:both; padding-left:10px; padding-top:5px; padding-right:5px; padding-bottom:5px"><a name="admin_mngbackup_000001"></a><a name="admin_mngbackup_000001"></a>

<h1 class="topictitle1">Configuring Management Data Backup</h1>
<div><p class="msonormal" id="admin_mngbackup_000001__en-us_topic_0000001792345722_en-us_topic_0219008867_en-us_topic_0171822343_p34341134">Before performing an upgrade or adjusting key data, you can back up management data on the <span id="admin_mngbackup_000001__en-us_topic_0000001792345722_text18445308218">OceanProtect</span> management page. The system then can use the backup data to restore configuration data (such as user, SLA, resource, and alarm notification data) in a timely manner if the data is deleted due to misoperations.</p>
<div class="section" id="admin_mngbackup_000001__en-us_topic_0000001792345722_section490323916381"><h4 class="sectiontitle">Context</h4><p id="admin_mngbackup_000001__en-us_topic_0000001792345722_p5793194743810">The management data that can be backed up using the <span id="admin_mngbackup_000001__en-us_topic_0000001792345722_text357517341717">OceanProtect</span> includes the KMC keystore file, KMC master key file, database file, ConfigMap, and certificate file.</p>
</div>
<div class="section" id="admin_mngbackup_000001__en-us_topic_0000001792345722_en-us_topic_0219008867_section19325121814565"><h4 class="sectiontitle">Precautions</h4><ul id="admin_mngbackup_000001__en-us_topic_0000001792345722_en-us_topic_0219008867_ul914784413561"><li id="admin_mngbackup_000001__en-us_topic_0000001792345722_li144713543477">If a job is being executed on the <span id="admin_mngbackup_000001__en-us_topic_0000001792345722_text111061656171217">OceanProtect</span>, you are advised not to initiate management data backup.</li><li id="admin_mngbackup_000001__en-us_topic_0000001792345722_li1383111372003">If a management data backup or restoration job is being executed, you are not allowed to execute the job again. If a manual job is being executed, the scheduled management data backup job will be canceled.</li><li id="admin_mngbackup_000001__en-us_topic_0000001792345722_li13910343192817">Backup can be performed only after a backup policy is configured.</li><li id="admin_mngbackup_000001__en-us_topic_0000001792345722_li9288258172012">The following descriptions are applicable to the product:<ul id="admin_mngbackup_000001__en-us_topic_0000001792345722_ul1473011352118"><li id="admin_mngbackup_000001__en-us_topic_0000001792345722_li42031756172311">When configuring management data backup, you are not allowed to enable the SFTP service. You can enable the SFTP service only after the backup is complete.</li><li id="admin_mngbackup_000001__en-us_topic_0000001792345722_li3726014286">Do not perform operations related to management data backup configuration when the SFTP service is being enabled. Perform these operations after the SFTP service is enabled.</li><li id="admin_mngbackup_000001__en-us_topic_0000001792345722_li1378312152315">The system management data backup policy has been configured before the SFTP service is enabled. After the SFTP service is enabled, system management data backup is automatically triggered.</li><li id="admin_mngbackup_000001__en-us_topic_0000001792345722_li19742456173512">If management data exists before the SFTP service is enabled, the existing management data files will become invalid after the SFTP service is enabled because the data files do not meet system restoration requirements. Invalid files can only be deleted.</li></ul>
</li></ul>
</div>
<div class="section" id="admin_mngbackup_000001__en-us_topic_0000001792345722_section1636356804"><h4 class="sectiontitle">Procedure</h4><ol id="admin_mngbackup_000001__en-us_topic_0000001792345722_en-us_topic_0219008867_ol463515012542"><li id="admin_mngbackup_000001__en-us_topic_0000001792345722_en-us_topic_0219008867_li7710556162219"><span>In the navigation pane, choose <span class="uicontrol" id="admin_mngbackup_000001__en-us_topic_0000001792345722_uicontrol16364191814613"><b>System &gt; Settings &gt; Management Data Backup</b></span>.</span></li><li id="admin_mngbackup_000001__en-us_topic_0000001792345722_li12607758203511"><span>Configure the management data backup policy.</span><p><div class="p" id="admin_mngbackup_000001__en-us_topic_0000001792345722_p4124851122713">In the <span class="wintitle" id="admin_mngbackup_000001__en-us_topic_0000001792345722_wintitle65728974384114"><b><span id="admin_mngbackup_000001__en-us_topic_0000001792345722_text195046009784114"><strong>Management Data Backup</strong></span></b></span> area, click <span class="uicontrol" id="admin_mngbackup_000001__en-us_topic_0000001792345722_uicontrol208700639984114"><b><span id="admin_mngbackup_000001__en-us_topic_0000001792345722_text78624931184114"><strong>Backup Policy</strong></span></b></span>. On the <span class="uicontrol" id="admin_mngbackup_000001__en-us_topic_0000001792345722_uicontrol6267430112514"><b><span id="admin_mngbackup_000001__en-us_topic_0000001792345722_text226773019258"><strong>Backup Policy</strong></span></b></span> page, set the backup policy parameters as described in <a href="#admin_mngbackup_000001__en-us_topic_0000001792345722_table1444913416580">Table 1</a>. Click <strong id="admin_mngbackup_000001__en-us_topic_0000001792345722_b9621697684114">OK</strong>.
<div class="tablenoborder"><a name="admin_mngbackup_000001__en-us_topic_0000001792345722_table1444913416580"></a><a name="en-us_topic_0000001792345722_table1444913416580"></a><table cellpadding="4" cellspacing="0" summary="" id="admin_mngbackup_000001__en-us_topic_0000001792345722_table1444913416580" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Backup policy parameters</caption><colgroup><col style="width:33.050000000000004%"><col style="width:66.95%"></colgroup><thead align="left"><tr id="admin_mngbackup_000001__en-us_topic_0000001792345722_row134507445811"><th align="left" class="cellrowborder" valign="top" width="33.050000000000004%" id="mcps1.3.4.2.2.2.1.6.2.3.1.1"><p id="admin_mngbackup_000001__en-us_topic_0000001792345722_p945014445814">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="66.95%" id="mcps1.3.4.2.2.2.1.6.2.3.1.2"><p id="admin_mngbackup_000001__en-us_topic_0000001792345722_p1845017425817">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="admin_mngbackup_000001__en-us_topic_0000001792345722_row134507495810"><td class="cellrowborder" valign="top" width="33.050000000000004%" headers="mcps1.3.4.2.2.2.1.6.2.3.1.1 "><p id="admin_mngbackup_000001__en-us_topic_0000001792345722_p31571742105813"><span id="admin_mngbackup_000001__en-us_topic_0000001792345722_text19607132312364"><strong>Backup Time</strong></span></p>
</td>
<td class="cellrowborder" valign="top" width="66.95%" headers="mcps1.3.4.2.2.2.1.6.2.3.1.2 "><p id="admin_mngbackup_000001__en-us_topic_0000001792345722_p9127121416115">Time for backing up data by day</p>
<p id="admin_mngbackup_000001__en-us_topic_0000001792345722_p41231654141018">If a manual backup job is being executed at the specified time, the automatic backup job will be automatically canceled.</p>
</td>
</tr>
<tr id="admin_mngbackup_000001__en-us_topic_0000001792345722_row44501243588"><td class="cellrowborder" valign="top" width="33.050000000000004%" headers="mcps1.3.4.2.2.2.1.6.2.3.1.1 "><p id="admin_mngbackup_000001__en-us_topic_0000001792345722_p1045004105811"><span id="admin_mngbackup_000001__en-us_topic_0000001792345722_text10705501192"><strong>Retained Backups</strong></span></p>
</td>
<td class="cellrowborder" valign="top" width="66.95%" headers="mcps1.3.4.2.2.2.1.6.2.3.1.2 "><p id="admin_mngbackup_000001__en-us_topic_0000001792345722_p884616199298">Number of latest available management data backups.</p>
<p id="admin_mngbackup_000001__en-us_topic_0000001792345722_p144501445816">The value must range from <strong id="admin_mngbackup_000001__en-us_topic_0000001792345722_b11609412334">3</strong> to <strong id="admin_mngbackup_000001__en-us_topic_0000001792345722_b181174403315">20</strong>.</p>
<p id="admin_mngbackup_000001__en-us_topic_0000001792345722_p15200351111">Default value: <strong id="admin_mngbackup_000001__en-us_topic_0000001792345722_b123281849133320">7</strong></p>
</td>
</tr>
<tr id="admin_mngbackup_000001__en-us_topic_0000001792345722_row20450646586"><td class="cellrowborder" valign="top" width="33.050000000000004%" headers="mcps1.3.4.2.2.2.1.6.2.3.1.1 "><p id="admin_mngbackup_000001__en-us_topic_0000001792345722_p184501949586"><span id="admin_mngbackup_000001__en-us_topic_0000001792345722_text19134175325813"><strong>SFTP IP Address</strong></span></p>
</td>
<td class="cellrowborder" rowspan="4" valign="top" width="66.95%" headers="mcps1.3.4.2.2.2.1.6.2.3.1.2 "><p id="admin_mngbackup_000001__en-us_topic_0000001792345722_p28061237698">Information about the SFTP server for storing backup files</p>
<p id="admin_mngbackup_000001__en-us_topic_0000001792345722_p16351103820252">Ensure that the SFTP user has the permission to read and write the <strong id="admin_mngbackup_000001__en-us_topic_0000001792345722_b14982154515580">/var</strong> directory.</p>
<p id="admin_mngbackup_000001__en-us_topic_0000001792345722_p11412045113417">After the SFTP IP address is changed, the backup records of the original SFTP server become invalid.</p>
<p id="admin_mngbackup_000001__en-us_topic_0000001792345722_p1099210421111">Default SFTP port: 22.</p>
</td>
</tr>
<tr id="admin_mngbackup_000001__en-us_topic_0000001792345722_row24505410584"><td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.2.1.6.2.3.1.1 "><p id="admin_mngbackup_000001__en-us_topic_0000001792345722_p61500014594"><span id="admin_mngbackup_000001__en-us_topic_0000001792345722_text17638720599"><strong>SFTP User Name</strong></span></p>
</td>
</tr>
<tr id="admin_mngbackup_000001__en-us_topic_0000001792345722_row215016018591"><td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.2.1.6.2.3.1.1 "><p id="admin_mngbackup_000001__en-us_topic_0000001792345722_p15450164125817"><span id="admin_mngbackup_000001__en-us_topic_0000001792345722_text2641457185816"><strong>SFTP Password</strong></span></p>
</td>
</tr>
<tr id="admin_mngbackup_000001__en-us_topic_0000001792345722_row41501307595"><td class="cellrowborder" valign="top" headers="mcps1.3.4.2.2.2.1.6.2.3.1.1 "><p id="admin_mngbackup_000001__en-us_topic_0000001792345722_p1746310568320"><span id="admin_mngbackup_000001__en-us_topic_0000001792345722_text8515173185918"><strong>SFTP Port</strong></span></p>
</td>
</tr>
<tr id="admin_mngbackup_000001__en-us_topic_0000001792345722_row6882185917194"><td class="cellrowborder" valign="top" width="33.050000000000004%" headers="mcps1.3.4.2.2.2.1.6.2.3.1.1 "><p id="admin_mngbackup_000001__en-us_topic_0000001792345722_p108832599197"><span id="admin_mngbackup_000001__en-us_topic_0000001792345722_text1583735617348"><strong>Backup Path</strong></span></p>
</td>
<td class="cellrowborder" valign="top" width="66.95%" headers="mcps1.3.4.2.2.2.1.6.2.3.1.2 "><p id="admin_mngbackup_000001__en-us_topic_0000001792345722_p20883459191910">Set a path for backing up management data. After a backup path is set, the path is automatically generated on the SFTP server. If this parameter is not set, the default value is <strong id="admin_mngbackup_000001__en-us_topic_0000001792345722_b9439227191214">/var/sysbackup</strong>.</p>
<div class="note" id="admin_mngbackup_000001__en-us_topic_0000001792345722_note168367919445"><span class="notetitle"> NOTE: </span><div class="notebody"><ul id="admin_mngbackup_000001__en-us_topic_0000001792345722_ul1811285351418"><li id="admin_mngbackup_000001__en-us_topic_0000001792345722_li1911225318145">Ensure that the SFTP user has the execute permission on your set backup path.</li><li id="admin_mngbackup_000001__en-us_topic_0000001792345722_li511235316145">If the SFTP user is user <strong id="admin_mngbackup_000001__en-us_topic_0000001792345722_b19927784213">root</strong>, enter an absolute path. Otherwise, enter a relative path.</li></ul>
</div></div>
</td>
</tr>
<tr id="admin_mngbackup_000001__en-us_topic_0000001792345722_row689471111593"><td class="cellrowborder" valign="top" width="33.050000000000004%" headers="mcps1.3.4.2.2.2.1.6.2.3.1.1 "><p id="admin_mngbackup_000001__en-us_topic_0000001792345722_p17895811195917"><span id="admin_mngbackup_000001__en-us_topic_0000001792345722_text148455211118"><strong>Data Encryption Password</strong></span></p>
</td>
<td class="cellrowborder" valign="top" width="66.95%" headers="mcps1.3.4.2.2.2.1.6.2.3.1.2 "><p id="admin_mngbackup_000001__en-us_topic_0000001792345722_p669281915177">Enter the password. The password is used to encrypt the system management data to ensure the security of the backup data. This password is also used for encryption in manual backup. Keep this password secure. When the system configurations need to be restored after a system fault, the password needs to be used to decrypt the backup system management data.</p>
</td>
</tr>
<tr id="admin_mngbackup_000001__en-us_topic_0000001792345722_row3895611175915"><td class="cellrowborder" valign="top" width="33.050000000000004%" headers="mcps1.3.4.2.2.2.1.6.2.3.1.1 "><p id="admin_mngbackup_000001__en-us_topic_0000001792345722_p3895111165920"><span id="admin_mngbackup_000001__en-us_topic_0000001792345722_text174141282117"><strong>Confirm Data Encryption Password</strong></span></p>
</td>
<td class="cellrowborder" valign="top" width="66.95%" headers="mcps1.3.4.2.2.2.1.6.2.3.1.2 "><p id="admin_mngbackup_000001__en-us_topic_0000001792345722_p2895711185912">Enter the data encryption password again.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</p></li><li id="admin_mngbackup_000001__en-us_topic_0000001792345722_li957018972813"><span>Click <span class="parmvalue" id="admin_mngbackup_000001__en-us_topic_0000001792345722_parmvalue660716235368"><b><span id="admin_mngbackup_000001__en-us_topic_0000001792345722_text3607172311365"><strong>Manual Backup</strong></span></b></span> to manually back up management data immediately.</span><p><div class="note" id="admin_mngbackup_000001__en-us_topic_0000001792345722_note161401422103318"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="admin_mngbackup_000001__en-us_topic_0000001792345722_p7233218342">During a manual backup, the system also uses the <span id="admin_mngbackup_000001__en-us_topic_0000001792345722_text322132193418"><strong>Data Encryption Password</strong></span> to encrypt management data. When the system recovers from a fault, the data encryption password is also required for decryption.</p>
</div></div>
</p></li><li id="admin_mngbackup_000001__en-us_topic_0000001792345722_li1552629123110"><span>On the <span class="parmvalue" id="admin_mngbackup_000001__en-us_topic_0000001792345722_parmvalue188673552084114"><b><span id="admin_mngbackup_000001__en-us_topic_0000001792345722_text54014399384114"><strong>Manual Backup</strong></span></b></span> page, enter the description and click <span id="admin_mngbackup_000001__en-us_topic_0000001792345722_text13148165616208"><strong>OK</strong></span>.</span></li></ol>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="admin_mngbackup_000000.html">Managing System Data Backup</a></div>
</div>
</div>

<div class="hrcopyright"><hr size="2"></div><div class="hwcopyright">Copyright &copy; Huawei Technologies Co., Ltd.</div></body>
</html>